/**
 * Copyright (C) BFH www.bfh.ch 2011
 * Code written by: Patrick Dobler, Marc Folly
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package ch.bfh.ti.kybernetik.lego.ki;

import ch.bfh.ti.kybernetik.lego.ki.RobKIFactr.Wesen;

/**
 * This Class represents the {@link RoboterKI} which is responsible to handle
 * incoming sensor values and change the actors according to them
 * 
 */
public interface RoboterKI {

	/**
	 * Returns a name in order to distinguish the different {@link RoboterKI}
	 * implementation and display that name on the GUI
	 * 
	 * @return the name of the {@link RoboterKI} implementation
	 */
	public abstract String getRoboterKIName();

	/**
	 * Set the new roboter motor speed for the left and right roboter motor
	 * according to the given light sensor intensity values
	 * 
	 * @param lightSensorLeftValue
	 *            left light sensor intensity value
	 * @param lightSensorRightValue
	 *            right light sensor intensity value
	 */
	public abstract void calculateNewRoboterMotorSpeed(int lightSensorLeftValue, int lightSensorRightValue);

	/**
	 * Stops both left and right roboter motors
	 */
	public abstract void stopMotor();

	/**
	 * The right roboter motor speed
	 * 
	 * @return the current right roboter motor speed
	 */
	public abstract int getMotorSpeedRight();

	/**
	 * The right roboter motor speed
	 * 
	 * @param motorSpeedRight
	 *            new right roboter motor speed to set
	 */
	public abstract void setMotorSpeedRight(int motorSpeedRight);

	/**
	 * The left roboter motor speed
	 * 
	 * @return the current left roboter motor speed
	 */
	public abstract int getMotorSpeedLeft();

	/**
	 * The left roboter motor speed
	 * 
	 * @param motorSpeedLeft
	 *            new left roboter motor speed to set
	 */
	public abstract void setMotorSpeedLeft(int motorSpeedLeft);

	/**
	 * Maximum value that the roboter sensor is able to detect
	 * 
	 * @return the maximum value the roboter lightSensor is able to detect
	 */
	public abstract int getLightMax();

	/**
	 * Maximum value that the roboter rensor is able to detect
	 * 
	 * @param lightMax
	 */
	public abstract void setLightMax(int lightMax);

	/**
	 * Minimal value that the roboter Sensor is able to detect
	 * 
	 * @return the minimal value that the roboter sensor is able to detect
	 */
	public abstract int getLightMin();

	/**
	 * Minimal value that the roboter Sensor is able to detect
	 * 
	 * @param lightMin
	 *            sets the minimal value that the roboter sensor is able to
	 *            detect
	 */
	public abstract void setLightMin(int lightMin);

	/**
	 * The {@link Wesen} in order to distinguish the different {@link RoboterKI}
	 * implementations
	 * 
	 * @return the {@link Wesen} of the {@link RoboterKI}
	 */
	public abstract Wesen getWesen();

}